home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / xancur.z / xancur / man / catn / xancur.n
Text File  |  1994-09-27  |  8KB  |  265 lines
  1.  
  2.  
  3.  
  4. XANCUR(1.4)          Talisman User Commands             Release 5
  5.  
  6.  
  7.  
  8. NAME
  9.      xancur - root cursor animation program for X
  10.  
  11. SYNOPSIS
  12.      xancur [-help] [-display _d_i_s_p_l_a_y] [-usleep _m_i_c_r_o_s_e_c_o_n_d_s]  [-
  13.      fg  _c_o_l_o_r]  [-bg  _c_o_l_o_r]  [-rv]  [-script _s_c_r_i_p_t_n_a_m_e] [-iter
  14.      _i_t_e_r_a_t_i_o_n_s] [_c_u_r_s_o_r_f_i_l_e _m_a_s_k_f_i_l_e]...
  15.  
  16. DESCRIPTION
  17.      The _x_a_n_c_u_r program allows the user to animate the background
  18.      ("root")  cursor  on  a workstation display running X.  Nor-
  19.      mally, one experiments with _x_a_n_c_u_r until one finds a  pleas-
  20.      ing,  personalized  look,  then puts the _x_a_n_c_u_r command that
  21.      produces it into an X  startup  file.   If  no  options  are
  22.      specified,  _x_a_n_c_u_r  will  attempt to read a scriptfile named
  23.      ._x_a_n_c_u_r  in  the  user's  home  directory  for  a  list   of
  24.      cursor/mask filenames.  Failing that, xancur will look for a
  25.      system scriptfile  defined  at  compilation  ---  see  _F_I_L_E_S
  26.      below.
  27.      _x_a_n_c_u_r can also be used for  program-to-user  communication,
  28.      by  using  a  meaningful  batch  animation  through a finite
  29.      number of iterations to indicate, for example,  the  comple-
  30.      tion  of a batch job.  It can also run until the xancur pro-
  31.      cess is killed by a catch on the end of a task.  The program
  32.      will  not, however, pause another invocation of itself while
  33.      running, so improper use could be less than esthetic.
  34.  
  35. OPTIONS
  36.      The various options are as follows:
  37.  
  38.      -help
  39.           Print a usage message and exit.
  40.  
  41.      _c_u_r_s_o_r_f_i_l_e _m_a_s_k_f_i_l_e
  42.           Filename pairs in this form are used to  set  the  root
  43.           cursor  animation frame sequence.  The enables the user
  44.           to specify the complete animation cycle  with  standard
  45.           cursor  and mask bitmaps as used by _x_s_e_t_r_o_o_t(_1). Cursor
  46.           and mask files are bitmaps (little pictures),  and  can
  47.           be  made with the _b_i_t_m_a_p(_1) program.  One usually wants
  48.           the mask files to be all black until one  becomes  more
  49.           familiar with the way masks work.
  50.  
  51.      -script _s_c_r_i_p_t_n_a_m_e
  52.           File _s_c_r_i_p_t_n_a_m_e contains  commands  (similar  to  those
  53.           used  on  the  the command line) and either cursor/mask
  54.           filename pairs or merely the name of the  cursor  files
  55.           to  which  .mask  will  be added to create the maskfile
  56.           names.
  57.  
  58.      -iter _i_t_e_r_a_t_i_o_n_s
  59.           This option sets  the  number  of  iterations  for  the
  60.  
  61.  
  62.  
  63. X Version 11                                                    1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XANCUR(1.4)          Talisman User Commands             Release 5
  71.  
  72.  
  73.  
  74.           complete  animation  loop.   If left unset, the program
  75.           will loop until interrupted.
  76.  
  77.      -fg _c_o_l_o_r
  78.           Use _c_o_l_o_r as the foreground color.
  79.  
  80.      -bg _c_o_l_o_r
  81.           Use _c_o_l_o_r as the background color.
  82.  
  83.      -rv  This exchanges the foreground  and  background  colors.
  84.           Normally  the  foreground  color is black and the back-
  85.           ground color is white.
  86.  
  87.      -display _d_i_s_p_l_a_y
  88.           Specifies the server to which to connect; see _X(_1).
  89.  
  90.      For convenience, xancur interprets the ~  (tilde)  character
  91.      in  the  same  way as that seen in the _c_s_h(_1).  This is also
  92.      true within scripts.
  93.  
  94.      It is not currently known precisely how many frames long  an
  95.      animation loop can be.  User should probably be warned that,
  96.      like many other aspects of customization, many days  can  be
  97.      lost in exploring such limits.
  98.  
  99. EXAMPLE
  100.      To have _x_a_n_c_u_r cycle through the two cursor/masks pairs  for
  101.      frames _b_m_1 and _b_m_2 one might run the following command.
  102.  
  103.           xancur -usleep 400000 bm1 bm1.mask bm2 bm2.mask
  104.  
  105.      More commonly, one might run the  following  in  the  _x_a_n_c_u_r
  106.      source directory.
  107.  
  108.           xancur -script animations/fourpoints/Script
  109.  
  110. SCRIPTS
  111.      The scriptfiles may contain image/mask filename pairs, image
  112.      filenames  with  assumed  .mask suffixes for mask filenames,
  113.      and command switches.  The command switches comprise a  sub-
  114.      set of the command line options, and include:
  115.  
  116.      -script _s_c_r_i_p_t_n_a_m_e
  117.  
  118.      -fg _c_o_l_o_r
  119.  
  120.      -bg _c_o_l_o_r
  121.  
  122.      -rv
  123.  
  124.      It is important to note that the dash-commands  do  _n_o_t  get
  125.      saved  or re-executed, but rather merely affect a particular
  126.  
  127.  
  128.  
  129. X Version 11                                                    2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XANCUR(1.4)          Talisman User Commands             Release 5
  137.  
  138.  
  139.  
  140.      cursor construction.  One should also note that  the  script
  141.      below  will  only work with the requisite X bitmaps resident
  142.      in the same directory as the script file.
  143.  
  144.      A variation of the default pointer, showing color reversal:
  145.  
  146.  
  147.           -bg white
  148.           -fg black
  149.           fourpoints0
  150.           fourpoints15
  151.           fourpoints30
  152.           fourpoints45
  153.           fourpoints60
  154.           fourpoints75
  155.           -rv
  156.           fourpoints0
  157.           fourpoints15
  158.           fourpoints30
  159.           fourpoints45
  160.           fourpoints60
  161.           fourpoints75
  162.  
  163.      It should be noted that any pathname within  a  script  file
  164.      which  is not a fully-rooted pathname will be resolved rela-
  165.      tive to the script file's location rather than  relative  to
  166.      the current working directory.
  167.  
  168. NOTES
  169.      Running xancur tends to prevent one's X  server  from  being
  170.      swapped  out as often.  This has been known to significantly
  171.      improve response time on some machines.
  172.  
  173. FILES
  174.      /usr/lib/X11/xancur/Script                  default (system) script.
  175.      $HOME/.xancur                      default (personal) script.
  176.      $HOME/.xinitrc        typical place for first xancur command.
  177.  
  178. SEE ALSO
  179.      csh(1),  X(1),  xinit(1),  xset(1),  xsetroot(1),   xrdb(1),
  180.      XDefineCursor(3X11)
  181.  
  182. BUGS
  183.      This version probably can't handle individual files of  over
  184.      64K in length.
  185.  
  186.      The program makes no use of the X resources for anything.
  187.  
  188. COPYRIGHT
  189.      Copyright (c) 1993, Christopher Alexander North-Keys
  190.  
  191.  
  192.  
  193.  
  194.  
  195. X Version 11                                                    3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XANCUR(1.4)          Talisman User Commands             Release 5
  203.  
  204.  
  205.  
  206.      Author's  credit  must  be  retained  in  binaries,   manual
  207.      entries, sources, and derived code.
  208.  
  209.      This software may be freely copied,  distributed,  compiled,
  210.      altered,  and  sold,  provided  the  above  restrictions are
  211.      observed.
  212.  
  213.      This software is provided "as is", with no warranty, guaran-
  214.      tee,  support,  maintenance, update schedule, claims to fit-
  215.      ness for any purpose, or anything else from  any  person  or
  216.      corporate  entity.  See the source code for additional copy-
  217.      right and limitation information.
  218.  
  219. AUTHOR
  220.      Christopher Alexander North-Keys, Group Talisman
  221.  
  222.      erlkonig@gnu.ai.mit.edu
  223.  
  224.      Special thanks to Mark Lillibridge, MIT Project Athena,  for
  225.      having  written  the  code  for  _x_s_e_t_r_o_o_t(1),  thanks to the
  226.      members of group Talisman (UT@Austin CCWF) for beta  testing
  227.      this  program  and  offering  comments,  and  thanks  to Mic
  228.      Kaczmarczik (UT@Austin CCWF) for proofreading this  documen-
  229.      tation,  checking the installation process, and checking the
  230.      spelling of his surname.
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261. X Version 11                                                    4
  262.  
  263.  
  264.  
  265.